System APIs
Adds a new parameter for a RamBase event type
| HTTP method | POST |
| URI | https://api.rambase.net/system/rambase-event-types/{rambaseEventTypeId}/parameters |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {rambaseEventTypeId} |
RamBase event type identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 269, version 10 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Key
Required/mandatory field
Name of the parameter
>{String}</Key>Datatype
Required/mandatory field
The datatype of the parameter
Applicable domain values can be found here
>{String}</Datatype>IsRequired
Determines whether or not this parameter is required for all Events of this Event Type (Y / N)
Default value: False
This field is optional.
>{Boolean}</IsRequired>Key
Required/mandatory field
Name of the parameter
": "{String}",Datatype
Required/mandatory field
The datatype of the parameter
Applicable domain values can be found here
": "{String}",IsRequired
Determines whether or not this parameter is required for all Events of this Event Type (Y / N)
Default value: False
This field is optional.
": "{Boolean}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
RamBaseEventTypeParameterId
RamBase event type parameter identifier
>{Integer}</RamBaseEventTypeParameterId>Key
Name of the parameter
>{String}</Key>Datatype
The datatype of the parameter
Possible domain values can be found here
>{String}</Datatype>IsRequired
Determines whether or not this parameter is required for all Events of this Event Type (Y / N)
>{Boolean}</IsRequired>RamBaseEventTypeParameterId
RamBase event type parameter identifier
": "{Integer}",Key
Name of the parameter
": "{String}",Datatype
The datatype of the parameter
Possible domain values can be found here
": "{String}",IsRequired
Determines whether or not this parameter is required for all Events of this Event Type (Y / N)
": "{Boolean}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 102567 HTTP 400 | Key of parameter is required |
| Error 101640 HTTP 400 | Data type is required |
| Error 102568 HTTP 400 | Parameter keys must be unique |